<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}
h4{
	margin-top:25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class=""><a href="study.html">学术讨论</a></li>
						<li class=""><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class=""><a href="coupon.html">优惠券</a></li>
						<li class=""><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class=""><a href="advert.html">广告</a></li>
						<li class="active"><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>公告系统API</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#reportSorts"><i class="icon-chevron-right"></i>
							获取全部公告分类API</a></li>
					<li><a href="#reportInfos"><i class="icon-chevron-right"></i>
							获取公告信息列表API</a></li>
					<li><a href="#reportInfo"><i class="icon-chevron-right"></i>
							获取某个公告信息API</a></li>
					
				</ul>

			</div>
			<div class="span9">



				<!-- Typography
        ================================================== -->
				<section id="reportSorts">
					<div class="page-header">
						<h1>获取公告分类API</h1>
					</div>
					
					<h3>1 功能说明</h3>
					<p>获取公告系统分类。</p>
					
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/report/sorts</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/report/sorts</p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。无。</p>
					
					<h4>2.5 请求示例</h4>
					<p><code>http://115.29.250.136:8080/homeInManchester/api/report/sorts</code></p>
					
					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>分类唯一标识。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>分类名称。</td>
							</tr>
							<tr>
								<td>parentId</td>
								<td>Integer</td>
								<td>上级分类ID</td>
							</tr>
							<tr>
								<td>moduleType</td>
								<td>Integer</td>
								<td>模块类型。1标示新闻分类；2标示公告分类。</td>
							</tr>
							<tr>
								<td>children</td>
								<td>List</td>
								<td>子分类集合。</td>
							</tr>
							<tr>
								<td>sortOrder</td>
								<td>Integer</td>
								<td>排列序号。</td>
							</tr>
							
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						
						<pre>
[
    {
        "sortId": 1, 
        "sortName": "娱乐", 
        "parentId": 0, 
        "moduleType": 2, 
        "children": [ ], 
        "sortOrder": 1
    }, 
    {
        "sortId": 2, 
        "sortName": "新闻", 
        "parentId": 0, 
        "moduleType": 2, 
        "children": [ ], 
        "sortOrder": 2
    }
]
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
	"code":1000,
	"msg":"网络错误，http请求异常。"
}
					</pre>
					
					
				</section>


<!-- Code
        ================================================== -->
				<section id="reportInfos">
					<div class="page-header">
						<h1>获取公告信息列表API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取公告具体信息列表</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/report/list</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/report/list</p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>选填</td>
								<td>Integer</td>
								<td>公告所属分类。默认或者0为全部。</td>
							</tr>
							<tr>
								<td>search</td>
								<td>选填</td>
								<td>String</td>
								<td>公告标题查询关键字。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>选填</td>
								<td>Integer</td>
								<td>第几页。默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>选填</td>
								<td>Integer</td>
								<td>一页显示条数，默认为8条，如果传0则显示全部，不分页。</td>
							</tr>
						</tbody>
					</table>
					
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/report/list?sortId=1</code>或者
					<code>http://115.29.250.136:8080/homeInManchester/api/report/list</code>
					
					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总的主题数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>公告信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>userId</td>
								<td>Integer</td>
								<td>扩展字段，暂时无意义。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>所属分类ID。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>所属分类名称。</td>
							</tr>
							<tr>
								<td>author</td>
								<td>String</td>
								<td>作者。</td>
							</tr>
							<tr>
								<td>views</td>
								<td>Integer</td>
								<td>浏览数</td>
							</tr>
							<tr>
								<td>praiseCount</td>
								<td>Integer</td>
								<td>点赞数</td>
							</tr>
							<tr>
								<td>praiseBaseCount</td>
								<td>Integer</td>
								<td>点赞基数</td>
							</tr>
							<tr>
								<td>commentCount</td>
								<td>Integer</td>
								<td>评论数</td>
							</tr>
							<tr>
								<td>commentBaseCount</td>
								<td>Integer</td>
								<td>评论基数。后台设置。</td>
							</tr>
							<tr>
								<td>newsId</td>
								<td>Integer</td>
								<td>新闻（公告）ID。</td>
							</tr>
							<tr>
								<td>newsTitle</td>
								<td>String</td>
								<td>公告标题。</td>
							</tr>
							<tr>
								<td>newsDesc</td>
								<td>String</td>
								<td>公告简介。</td>
							</tr>
							<tr>
								<td>newsLogo</td>
								<td>String</td>
								<td>公告封面缩略图。文件路径。</td>
							</tr>
							<tr>
								<td>newsImages</td>
								<td>String</td>
								<td>多个宣传图片字符串，为图片上传地址，中间用逗号隔开。</td>
							</tr>
							<tr>
								<td>newsType</td>
								<td>Integer</td>
								<td>新闻类型。1标示新闻；2标示公告。</td>
							</tr>
							<tr>
								<td>showInIndex</td>
								<td>Integer</td>
								<td>是否显示在首页。</td>
							</tr>
							<tr>
								<td>publishTime</td>
								<td>String</td>
								<td>发布时间。</td>
							</tr>
							<tr>
								<td>newsDetails</td>
								<td>text</td>
								<td>公告详细内容。html文本。</td>
							</tr>
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						<code>http://115.29.250.136:8080/homeInManchester/api/report/list</code>
						<pre>
{
    "result": [
        {
            "userId": 0, 
            "sortId": 1, 
            "sortName": "娱乐", 
            "author": "是否2", 
            "views": 5, 
            "praiseCount": 16, 
            "praiseBaseCount": 4, 
            "commentCount": 12, 
            "commentBaseCount": 3, 
            "newsId": 1, 
            "newsTitle": "舒服舒服1", 
            "newsDesc": "说法士大夫", 
            "newsLogo": "ec25b54b-71aa-4d05-a621-1536eeaebb78.jpg", 
            "newsImages": "37cba6ca-fd72-46f7-9df1-629efae1f037.png,80be76d0-5da4-4bd0-aa6f-f289ce98c326.png", 
            "newsType": 2, 
            "showInIndex": 0, 
            "publishTime": "2015-01-06 14:18:16", 
            "newsDetails": ""
        }, 
        {
            "userId": 0, 
            "sortId": 1, 
            "sortName": "娱乐", 
            "author": "胜多负少", 
            "views": 3, 
            "praiseCount": 6, 
            "praiseBaseCount": 2, 
            "commentCount": 3, 
            "commentBaseCount": 1, 
            "newsId": 3, 
            "newsTitle": "司法所", 
            "newsDesc": "胜多负少发大水", 
            "newsLogo": "c4cddb7a-987a-421c-a462-9af5352cd758.png", 
            "newsImages": "", 
            "newsType": 2, 
            "showInIndex": 1, 
            "publishTime": "2015-01-06 14:18:12", 
            "newsDetails": ""
        }
    ], 
    "pageNum": 1, 
    "numPerPage": 8, 
    "totalPage": 1, 
    "totalCount": 2
}
						</pre>
					
					
					

				</section>
				
				<section id="reportInfo">
					<div class="page-header">
						<h1>获取信公告息具体内容API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取具体信息内容</p>
					
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/report/info</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/report/info</p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>newsId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>信息ID。</td>
							</tr>
						</tbody>
					</table>
					
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/report/info?newsId=1</code>
					
					<h4>2.6 返回参数说明</h4>
					<p>
					返回内容参考上面公告信息列表描述。
					</p>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						<code>http://115.29.250.136:8080/homeInManchester/api/report/info&newsId=1</code>
						<pre>
{
    "userId": 0, 
    "sortId": 1, 
    "sortName": null, 
    "author": "是否2", 
    "views": 5, 
    "praiseCount": 16, 
    "praiseBaseCount": 4, 
    "commentCount": 12, 
    "commentBaseCount": 3, 
    "newsId": 1, 
    "newsTitle": "舒服舒服1", 
    "newsDesc": "说法士大夫", 
    "newsLogo": "ec25b54b-71aa-4d05-a621-1536eeaebb78.jpg", 
    "newsImages": "37cba6ca-fd72-46f7-9df1-629efae1f037.png,80be76d0-5da4-4bd0-aa6f-f289ce98c326.png", 
    "newsType": 2, 
    "showInIndex": 0, 
    "publishTime": "2015-01-06 14:18:16", 
    "newsDetails": ""
}
						</pre>
					
					
						
					<h4>2.9 错误返回示例</h4>
					<pre>
{
	"code":1000,
	"msg":"网络错误，http请求异常。"
}
					</pre>
					

				</section>
				
				

			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
